Expand nostrdb docs & mdbook#99
Open
alltheseas wants to merge 8 commits into
Open
Conversation
Author
|
Mdbook example screenshot |
Contributor
|
thanks! I'll take a look |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
0b2bcffAdd a real front door toREADME.md: platform requirements,quickstart, sample data workflow, and pointers to the new docs.
e2c7c88Introducedocs/getting-started.mdwith environment setup, build/test targets, fixture ingestion, a minimal C example, and troubleshooting
tips.
a732b86Document nostrdb’s storage architecture—LMDB layout, packed notes/metadata, ingestion/query flow, and guidance for extending the engine safely.
56a7529Create an API tour covering the major surfaces insrc/nostrdb.hwith code snippets for config, ingestion, filters, queries, and metadata
builders.
8036743Write a fullndbCLI guide detailing every command/flag, commonworkflows, and index-debug helpers.
54a9edaCatalog the generated C/Rust/Swift bindings, regenerationcommands, and usage notes so consumers know what’s available today.
ea1ec10Stand up an mdBook site (docs/book/) that stitches all docs intoa browsable book, plus README instructions for serving/building it.
e0f85d5Fix mdBook include paths and ignore the build artifacts somdbook serve docs/book --openworks cleanly.